Skip to content

docs: rewrite README.md in English with full project description - #32

Merged
makuchpatryk merged 2 commits into
feat-multi-selectfrom
copilot/update-readme-description
Feb 23, 2026
Merged

docs: rewrite README.md in English with full project description#32
makuchpatryk merged 2 commits into
feat-multi-selectfrom
copilot/update-readme-description

Conversation

Copilot AI commented Feb 23, 2026

Copy link
Copy Markdown
Contributor

The existing README was the default Nuxt 3 starter template — it said nothing about the actual application.

Replaced with a complete project README covering:

  • Overview — one-line tagline + short description of the puzzle mechanic
  • Features — real photos via Pexels, 3 difficulty grids, drag & swap, stopwatch, pause/resume, i18n, responsive
  • Tech stack — Nuxt 3, Pinia, Tailwind CSS, Vitest, Playwright, ESLint/Prettier, pnpm
  • Getting started — prerequisites (Node ≥ 18, pnpm, Pexels API key), install steps, .env setup, dev server
  • How to play — step-by-step game guide including multi-select tile drag
  • Project structure — annotated directory tree of the modular layout (core/, game/, ui/, server/api/)
  • API endpoints — documents the two server-side Pexels proxy routes
  • Testing & code quality — all pnpm test*, lint, lintfix commands
  • Production build — build/preview commands with link to Nuxt deployment docs
Original prompt

napisz mi jakies ladne Readme co lepiej opisze aplikacje ale po angielsku

The user has attached the following files from their workspace:

  • modules/core/index.ts

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

@vercel

vercel Bot commented Feb 23, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
perplex-image Ready Ready Preview, Comment Feb 23, 2026 10:48pm

Co-authored-by: makuchpatryk <19875907+makuchpatryk@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README to better describe application docs: rewrite README.md in English with full project description Feb 23, 2026
Copilot AI requested a review from makuchpatryk February 23, 2026 22:48
@makuchpatryk
makuchpatryk marked this pull request as ready for review February 23, 2026 23:13
@makuchpatryk
makuchpatryk merged commit 1de8892 into feat-multi-select Feb 23, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants